GetUDString

SoftwareShield ClientProtector COM Component > ClientProtector (SSCProtector) Reference > GetUDString

## GetUDString

The GetUDString function retrieves one of the user defined strings stored in the license based on an index.

###### Syntax

HRESULT GetUDString ( long Index, BSTR * UDString );

###### Parameters

Index

[IN] Numeric value between 0 and 9 inclusive corresponding to the index of the string which you wish to retrieve.

UDString

[OUT] This is (a pointer to) a wide character string which will receive the specified string.

###### Remarks

The GetUDString function retrieves one of the user defined strings stored in the license based on the numeric index you pass in Index. If Index is not within range (0 to 9 inclusive) the result is undefined.

These fields are dynamically allocated strings and have no declared maximum length. The theoretical maximum length of these string values is 2GB (two gigabytes). In practice this means that the maximum length of these strings is limited only by the amount of memory available to your application.

###### Return Value

As with all COM function calls they return an HRESULT. HRESULT is a data type that is a 32-bit error or warning code. Check your compilers documentation for information on interpreting the HRESULT value.

###### Function Information

Exposed By Interface: | "ISSCProtector"
Exposed In COM Server Binaries: | "SSCProt.dll" and "SSCProtD.dll"